Use the Composition Target Render Pass to set one to four composition targets and render all descendant render passes to the composition targets that the Composition Target Render Pass created.
More...
|
| Framebuffer * | getFramebuffer () |
| | Gets the internal framebuffer structure.
|
| |
| const Framebuffer * | getFramebuffer () const |
| | Gets the internal framebuffer structure (const version).
|
| |
| MaterialSharedPtr | getColorMipmapMaterial0 () const |
| | Gets the value of the ColorMipmapMaterial0Property property.
|
| |
| MaterialSharedPtr | getColorMipmapMaterial1 () const |
| | Gets the value of the ColorMipmapMaterial1Property property.
|
| |
| MaterialSharedPtr | getColorMipmapMaterial2 () const |
| | Gets the value of the ColorMipmapMaterial2Property property.
|
| |
| MaterialSharedPtr | getColorMipmapMaterial3 () const |
| | Gets the value of the ColorMipmapMaterial3Property property.
|
| |
| MaterialSharedPtr | getCubemapMipmapMaterial () const |
| | Gets the value of the CubemapMipmapMaterialProperty property.
|
| |
| float | getCurrentMipmapLevel () const |
| | Gets the value of the CurrentMipmapLevelProperty property.
|
| |
| MaterialSharedPtr | getDepthMipmapMaterial () const |
| | Gets the value of the DepthMipmapMaterialProperty property.
|
| |
| TextureSharedPtr | getMipmapSourceTexture () const |
| | Gets the value of the MipmapSourceTextureProperty property.
|
| |
| void | setColorMipmapMaterial0 (MaterialSharedPtr value) |
| | Sets the value of the ColorMipmapMaterial0Property property.
|
| |
| void | setColorMipmapMaterial1 (MaterialSharedPtr value) |
| | Sets the value of the ColorMipmapMaterial1Property property.
|
| |
| void | setColorMipmapMaterial2 (MaterialSharedPtr value) |
| | Sets the value of the ColorMipmapMaterial2Property property.
|
| |
| void | setColorMipmapMaterial3 (MaterialSharedPtr value) |
| | Sets the value of the ColorMipmapMaterial3Property property.
|
| |
| void | setCubemapMipmapMaterial (MaterialSharedPtr value) |
| | Sets the value of the CubemapMipmapMaterialProperty property.
|
| |
| void | setCurrentMipmapLevel (float value) |
| | Sets the value of the CurrentMipmapLevelProperty property.
|
| |
| void | setDepthMipmapMaterial (MaterialSharedPtr value) |
| | Sets the value of the DepthMipmapMaterialProperty property.
|
| |
| void | setMipmapSourceTexture (TextureSharedPtr value) |
| | Sets the value of the MipmapSourceTextureProperty property.
|
| |
| void | addChild (RenderPassSharedPtr childRenderPass) |
| | Adds a render pass as the last child of the render pass you set.
|
| |
| void | attach () |
| | Attaches the render pass.
|
| |
| void | attachRecursive (Node &node) |
| | Recursively attaches a render pass tree.
|
| |
| ChildConstIterator | beginChildren () const |
| | Returns an iterator to the beginning of the container of child render passes.
|
| |
| BindingLookupContextPtr | createLookupContext (RenderPassSharedPtr templateRoot) |
| | Creates a lookup context for a given render pass.
|
| |
| void | detach () |
| | Detaches the render pass.
|
| |
| void | detachRecursive () |
| | Recursively detaches a render pass tree.
|
| |
| ChildConstIterator | endChildren () const |
| | Returns an iterator to the end of the container of child render passes.
|
| |
| string | getCamera () const |
| | Gets the value of the CameraProperty.
|
| |
| RenderPassSharedPtr | getChild (size_t index) |
| | Gets a child render pass at the given index.
|
| |
| size_t | getChildCount () const |
| | Returns the number of child render passes.
|
| |
| size_t | getChildIndex (RenderPass &childRenderPass) const |
| | Gets the index of a child in this render pass.
|
| |
| Node * | getHostNode () const |
| | Gets the host node of a render pass.
|
| |
| Vector4 | getInputViewport () const |
| | Gets the value of InputViewportAreaProperty.
|
| |
| RenderPass * | getParent () const |
| | Gets the parent of a render pass.
|
| |
| Scene * | getSceneForRenderPass () const |
| | Gets the scene being rendered by the render pass.
|
| |
| RenderPassSharedPtr | getTemplateRoot () const |
| | Gets the template root of this render pass.
|
| |
| int | getUpdateOffset () const |
| | Gets the update offset of the Render Pass.
|
| |
| int | getUpdateRate () const |
| | Gets the value of UpdateRateProperty.
|
| |
| Viewport2D * | getViewportForRenderPass () const |
| | Gets a viewport parent for a render pass.
|
| |
| void | insertChild (size_t index, RenderPassSharedPtr childRenderPass) |
| | Adds a render pass as a child render pass at given index of the render pass you set.
|
| |
| bool | isAttached () const |
| | Tells if a render pass is attached.
|
| |
| bool | isAttaching () const |
| | Tells if a render pass is attaching.
|
| |
| bool | isDetached () const |
| | Tells if a render pass is detached.
|
| |
| bool | isDetaching () const |
| | Tells if render pass is detaching.
|
| |
| bool | isEnabled () const |
| | Gets the value of the EnabledProperty property.
|
| |
| ObjectSharedPtr | lookupObject (string_view relativePath) |
| | Lookup for an object from a node.
|
| |
| template<typename T > |
| shared_ptr< T > | lookupObject (string_view relativePath) |
| | Lookup a relative object of specific type.
|
| |
| void | removeAllChildren () |
| | Removes all child render passes from a render pass.
|
| |
| void | removeChild (RenderPass &childRenderPass) |
| | Removes a child render pass.
|
| |
| void | removeChild (size_t index) |
| | Removes a child render pass.
|
| |
| void | render (Renderer3D &renderer, CompositionStack &compositionStack, const CameraSettings *cameraSettings) |
| | Recursively render RenderPass and all of its child render passes.
|
| |
| void | restoreResourcesRecursive () |
| | Recursively calls restoreResources for a RenderPass and all its children.
|
| |
| void | setCamera (string_view value) |
| | Sets the value of the CameraProperty.
|
| |
| void | setEnabled (bool value) |
| | Sets the value of the EnabledProperty.
|
| |
| void | setHostNode (Node *hostNode) |
| | Sets the host node of a render pass.
|
| |
| void | setParent (RenderPass *parent) |
| | Sets the parent of a render pass.
|
| |
| void | setTemplateRoot (RenderPassSharedPtr templateRoot) |
| | Sets the template root for this render pass.
|
| |
| void | setUpdateRate (int updateRate) |
| | Sets the value of UpdateRateProperty.
|
| |
| void | setUpdateRateOffset (int updateOffset) |
| | Sets the value of UpdateOffsetProperty.
|
| |
| | ~RenderPass () override |
| | Destructor.
|
| |
| void | destroy () |
| | Destroys a GPU resource.
|
| |
| unsigned int | getGPUMemoryUsage () const |
| |
| Renderer * | getRenderer () const |
| |
| void | invalidate () |
| | Notify resource that graphics context was lost and all GPU resources are invalid.
|
| |
| bool | isDeployed () const |
| |
| | ~GPUResource () override |
| |
| virtual unsigned int | getCPUMemoryUsage () const |
| | Function for getting the memory usage of a resource.
|
| |
| const string & | getName () const |
| | Gets the resource name.
|
| |
| const string & | getUrl () const |
| | Gets the resource URL.
|
| |
| bool | isKeepAlive () const |
| | Tells if the resource has keep alive flag set.
|
| |
| void | reload () |
| |
| void | reloadFromFile (string_view filePath) |
| |
| void | reloadFromKzb (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser) |
| |
| void | setKeepAlive (bool keepAlive) |
| | Sets the keep alive flag.
|
| |
| void | setUrl (string_view url) |
| | Sets the resource URL.
|
| |
| | ~Resource () override |
| | Destructor.
|
| |
| AppliedStyleEntrySharedPtr | applyObjectStyle (kanzi::StyleSharedPtr style) |
| | Applies a style to an object.
|
| |
| void | applyObjectStyles () |
| | Apply all styles for an object node.
|
| |
| Domain * | getDomain () const |
| | Returns the domain the object belongs to.
|
| |
| const Metaclass * | getDynamicMetaclass () const override |
| | Returns the metaclass of the dynamic type of the object.
|
| |
| MainLoopScheduler * | getMainLoopScheduler () const |
| | Returns the MainLoopScheduler instance of the associated Domain.
|
| |
| detail::MessageDispatcher * | getMessageDispatcher () const |
| | Returns the message dispatcher of the object.
|
| |
| ResourceManager * | getResourceManager () const |
| | Returns the resource manager of the object.
|
| |
| ScriptingContextSharedPtr | getScriptingContext () const |
| | Gets the scripting context of the object.
|
| |
| | Object (Domain *domain) |
| |
| void | setScriptingContext (ScriptingContextSharedPtr context) |
| | Sets the scripting context of the object.
|
| |
| void | unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry) |
| |
| void | unapplyObjectStyles () |
| | Unapplies and removes all applied styles.
|
| |
| | ~Object () override |
| |
| bool | isTypeOf (const Metaclass *objectType) const |
| | Determines if the type of this object is the given type or derived from it.
|
| |
| virtual | ~MetaObject () |
| |
| template<typename DataType > |
| void | addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner) |
| |
| template<typename DataType > |
| void | addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner) |
| | Adds a property modifier without notifying handlers.
|
| |
| template<typename DataType > |
| void | addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner) |
| |
| template<typename DataType > |
| void | addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner) |
| |
| template<typename DataType > |
| void | addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer) |
| |
| PropertyStorageContainer::iterator | beginPropertyStorage () |
| | Returns the begin iterator to the internal property storage container.
|
| |
| PropertyStorageContainer::const_iterator | beginPropertyStorage () const |
| | Returns the begin iterator to the internal property storage container.
|
| |
| void | clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag) |
| |
| void | copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType) |
| | Copies local value of single property from another object.
|
| |
| void | copyLocalValues (const PropertyObject &other) |
| | Copies all local values from another object.
|
| |
| PropertyStorageContainer::iterator | endPropertyStorage () |
| | Returns the end iterator to the internal property storage container.
|
| |
| PropertyStorageContainer::const_iterator | endPropertyStorage () const |
| | Returns the end iterator to the internal property storage container.
|
| |
| template<typename DataType > |
| PropertyType< DataType >::Traits::ReturnType | getAbstractProperty (AbstractPropertyType abstractPropertyType) const |
| |
| template<typename DataType > |
| PropertyType< DataType >::Traits::ReturnType | getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const |
| |
| template<typename DataType > |
| optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const |
| |
| template<typename DataType > |
| optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalProperty (const PropertyType< DataType > &propertyType) const |
| | Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value.
|
| |
| template<typename DataType > |
| optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const |
| | Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value.
|
| |
| template<typename DataType > |
| PropertyType< DataType >::Traits::ReturnType | getProperty (const PropertyType< DataType > &propertyType) const |
| | Returns the current value of a property type.
|
| |
| template<typename DataType > |
| PropertyType< DataType >::Traits::ReturnType | getPropertyBase (const PropertyType< DataType > &propertyType) const |
| | Returns the current value of a property disregarding modifiers.
|
| |
| template<typename DataType > |
| size_t | getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const |
| | Gets number of current notification handlers for given property type.
|
| |
| bool | hasBaseValue (AbstractPropertyType propertyType) const |
| | Evaluates whether there are any inputs into the property value, disregarding modifiers.
|
| |
| bool | hasLocalValue (AbstractPropertyType propertyType) const |
| | Evaluates whether there is a local value set for the property.
|
| |
| bool | hasNonClassValue (AbstractPropertyType propertyType) const |
| | Evaluates whether there is a value of any precedence higher than class default value set for the property.
|
| |
| bool | hasValue (AbstractPropertyType propertyType) const |
| | Evaluates whether there are any inputs into the property value.
|
| |
| bool | isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const |
| |
| | PropertyObject () |
| |
| void | removeKzbProperties () |
| | Remove all KZB properties.
|
| |
| void | removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties) |
| | Remove all KZB properties that are not included in a given set.
|
| |
| template<typename DataType > |
| void | removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer) |
| |
| void | removeLocalValue (AbstractPropertyType propertyType) |
| | Removes the local value associated with the property.
|
| |
| template<typename DataType > |
| void | removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner) |
| |
| template<typename DataType > |
| void | removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner) |
| |
| template<typename DataType > |
| void | removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer) |
| |
| template<typename DataType > |
| void | setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value) |
| |
| template<typename DataType > |
| void | setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value) |
| | Sets the local value of a property type.
|
| |
| void | setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag) |
| |
| KZ_DEPRECATED void | validatePropertyModifiers (AbstractPropertyType propertyType) |
| | Validates property modifiers and notifies handlers.
|
| |
| void | validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType) |
| | Validates property modifiers and notifies handlers.
|
| |
| virtual | ~PropertyObject () |
| |
| void | addBindingRuntime (AbstractBindingRuntimeSharedPtr entry, shared_ptr< void > owner) |
| | Adds an already-created binding runtime to this binding host.
|
| |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding) |
| | Wrapper for setting a binding with no target.
|
| |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType) |
| | Wrapper for setting a binding.
|
| |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field) |
| | Wrapper for setting a binding.
|
| |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence) |
| | Wrapper for setting a binding.
|
| |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyValuePrecedence precedence) |
| | Wrapper for setting a binding.
|
| |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, shared_ptr< RenderPass > templateRoot) |
| | Sets a binding with no target.
|
| |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field) |
| | Wrapper for setting a binding.
|
| |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence) |
| | Wrapper for setting a binding.
|
| |
| BindingRuntimeHandle | setBinding (AbstractBindingSharedPtr binding, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyValuePrecedence precedence) |
| | Wrapper for setting a binding.
|
| |
| BindingRuntimeHandle | setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner) |
| | Wrapper for setting a binding with no target.
|
| |
| BindingRuntimeHandle | setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType) |
| | Wrapper for setting a binding with owner.
|
| |
| BindingRuntimeHandle | setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence) |
| | Wrapper for setting a binding with owner.
|
| |
| BindingRuntimeHandle | setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< RenderPass > templateRoot) |
| | Sets a binding with no target.
|
| |
| BindingRuntimeHandle | setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence) |
| | Sets a binding to a certain property.
|
| |
| BindingRuntimeHandle | setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType) |
| | Wrapper for setting a modifier binding.
|
| |
| BindingRuntimeHandle | setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field) |
| | Wrapper for setting a modifier binding.
|
| |
| BindingRuntimeHandle | setModifierBinding (AbstractBindingSharedPtr binding, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field) |
| | Wrapper for setting a modifier binding.
|
| |
| BindingRuntimeHandle | setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType) |
| | Wrapper for setting a modifier binding.
|
| |
| BindingRuntimeHandle | setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field) |
| | Wrapper for setting a modifier binding.
|
| |
| BindingRuntimeHandle | setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field) |
| | Sets a modifier binding.
|
| |
| BindingRuntimeConstIterator | beginBindingRuntimes () const |
| | Returns an iterator to the beginning of binding runtimes.
|
| |
| BindingRuntimeConstIterator | endBindingRuntimes () const |
| | Returns an iterator to the end of binding runtimes.
|
| |
| AbstractBindingRuntimeSharedPtr | getBindingRuntime (size_t idx) |
| | Gets binding by index.
|
| |
| size_t | getBindingRuntimeCount () const |
| | Gets the number of binding runtimes added to this node.
|
| |
| void | removeAllBindings () |
| | Removes all binding runtimes.
|
| |
| void | removeBinding (BindingRuntimeHandle &bindingRuntime) |
| | Removes a binding runtime added earlier.
|
| |
| void | removeBindingsWithOwner (shared_ptr< void > owner) |
| | Removes all binding runtimes with the specified owner.
|
| |
|
| void | clearInternalResources () |
| | Clear internal resources that Kanzi created when executing this render pass.
|
| |
| | CompositionTargetRenderPass (Domain *domain, string_view name) |
| | Constructor.
|
| |
| void | destroyOverride () override |
| | GPUResource::destroyOverride() implementation.
|
| |
| CompositionRequirements | getCompositionRequirements () override |
| | RenderPass::getCompositionRequirements() implementation.
|
| |
| CompositionFormatSettings | getRequestedCompositionSettings (GraphicsFormat colorFormat, GraphicsFormat depthTextureFormat, GraphicsFormat depthRenderbufferFormat, const CompositionSizeSettings &sizeSettings) const |
| | Gets the composition settings based on properties.
|
| |
| CompositionFormatSettings | getRequestedCompositionSettings (Texture &compositionTarget, const CompositionSizeSettings &sizeSettings, optional< GraphicsFormat > colorFormat) const |
| | Gets the composition settings based on explicitly set composition target.
|
| |
| void | invalidateOverride () override |
| | GPUResource::invalidateOverride() implementation.
|
| |
| bool | isDeployedOverride () const override |
| | GPUResource::isDeployedOverride() implementation.
|
| |
| void | onDetached () override |
| | RenderPass::onDetached() implementation.
|
| |
| void | onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override |
| | Object::onPropertyChanged() implementation.
|
| |
| void | renderMipmaps (BrushRenderer &mipmapRenderer, TextureSharedPtr texture) |
| | Renders mipmaps for the given texture using a material.
|
| |
| void | renderOverride (Renderer3D &renderer, CompositionStack &compositionStack, const CameraSettings *cameraSettings) override |
| | RenderPass::renderOverride() implementation.
|
| |
| void | resolveCompositionResults (Renderer3D &renderer, CompositionStack &compositionStack, const optional< CompositionManager::Target > &drawTarget, CompositionManager::Target &resultTarget, int attachmentIndex) |
| | Resolves composition targets and sets appropriate properties.
|
| |
| void | restoreResources () override |
| | RenderPass::restoreResources() implementation.
|
| |
| void | updateComposition (optional< CompositionManager::Target > &drawTarget, optional< CompositionManager::Target > &resultTarget, Renderer3D &renderer, TextureSharedPtr colorTarget, const CompositionFormatSettings &settings, const CompositionRequirements &requirements) |
| | Updates the composition targets based on properties and potential existing composition target.
|
| |
| void | updateComposition (Renderer3D &renderer, Vector2 viewportSize, const CompositionRequirements &childCompositionRequirements) |
| | Updates all composition settings.
|
| |
| | MipmapGenerationConceptImpl (Domain *domain, string_view name) |
| | Constructor.
|
| |
| void | onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override |
| | Object::onPropertyChanged() implementation.
|
| |
| Camera * | acquireCamera (string_view relativePath) const |
| | Acquires a Camera node based on the value of the Camera property.
|
| |
| CompositionRequirements | combineChildCompositionRequirements (CompositionRequirements requirements) |
| | Iterates the children for composition requirements.
|
| |
| CompositionRequirements | getChildCompositionRequirements () |
| | Iterates the children for composition requirements.
|
| |
| virtual void | onAttached () |
| | Called when a render pass becomes attached.
|
| |
| void | onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override |
| | Object::onPropertyChanged() implementation.
|
| |
| void | renderChildren (Renderer3D &renderer, CompositionStack &compositionStack, const CameraSettings *cameraSettings) |
| | Render all child render passes of a render pass.
|
| |
| virtual void | renderChildrenOverride (Renderer3D &renderer, CompositionStack &compositionStack, const CameraSettings *cameraSettings) |
| | Implementation-dependent rendering of all child render passes of a render pass.
|
| |
| | RenderPass (Domain *domain, string_view name) |
| | Constructor.
|
| |
| template<typename T > |
| void | updatePropertyValueSourceAndNotify (AbstractPropertyType propertyType, typename PropertyType< T >::Descriptor::TypedValueSource &valueSource, const T &value) |
| | Updates the local value of a property in a Draw Objects Render Pass.
|
| |
| virtual unsigned int | getGPUMemoryUsageOverride () const |
| | Gets the amount of GPU memory consumed by the resource.
|
| |
| | GPUResource (Domain *domain, string_view name="") |
| | Constructor.
|
| |
| virtual unsigned int | getCPUMemoryUsageOverride () const |
| |
| virtual void | reloadFromFileOverride (string_view filePath) |
| |
| virtual void | reloadFromKzbOverride (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser) |
| |
| virtual void | reloadOverride () |
| |
| | Resource (Domain *domain, string_view name) |
| | Constructor.
|
| |
| void | initialize () |
| |
| void | onCopy (const Object &other) |
| |
| void | initialize () |
| |
| | MetaObject () |
| |
| AbstractPropertyTypeDescriptor::ValueSourceEntry * | acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage) |
| | Acquires a local value source entry that is free for the assignment of a value.
|
| |
| AbstractPropertyTypeDescriptor::ModifierStorage * | acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) |
| |
| AbstractPropertyTypeDescriptor::NotificationStorage * | acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) |
| |
| PropertyStoragePtr | acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor) |
| |
| template<typename DataType > |
| void | addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify) |
| | Adds a property modifier entry to the property modifier stack and validates them.
|
| |
| void | addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner) |
| | Internally adds a property value source.
|
| |
| void | addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer) |
| | Internally adds a property value source.
|
| |
| AbstractPropertyTypeDescriptor::ValueSourceEntry * | constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) |
| |
| PropertyStoragePtr | constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) |
| |
| void | copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage) |
| | Copy local value from property storage.
|
| |
| AbstractPropertyTypeDescriptor::ModifierStorage * | findModifierStorage (AbstractPropertyTypeDescriptor &descriptor) |
| |
| AbstractPropertyTypeDescriptor::NotificationStorage * | findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const |
| |
| AbstractPropertyTypeDescriptor::PropertyStorage * | findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const |
| | Gets the property storage for given property type descriptor.
|
| |
| PropertyStoragePtr | findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const |
| | Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation.
|
| |
| AbstractPropertyTypeDescriptor * | findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const |
| | Finds a property type descriptor by name and data type.
|
| |
| AbstractPropertyTypeDescriptor * | findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const |
| | Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names.
|
| |
| AbstractPropertyTypeDescriptor * | findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const |
| | Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names.
|
| |
| AbstractPropertyTypeDescriptor::ValueSource * | getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const |
| |
| AbstractPropertyTypeDescriptor::ValueSource * | getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const |
| |
| AbstractPropertyTypeDescriptor::ValueSource * | getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const |
| |
| AbstractPropertyTypeDescriptor::ValueSource * | getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const |
| | Gets the top-level value source for a given property descriptor.
|
| |
| virtual void | notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason) |
| | Notifies all property handlers on a property storage.
|
| |
| void | onCopy (const PropertyObject &other) |
| |
| void | removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage) |
| | Removes a local value from the given property storage.
|
| |
| void | removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner) |
| | Removes a property value source.
|
| |
| void | validatePropertyModifiers (PropertyStoragePtr &propertyStorage) |
| | Validates property modifiers without notifying handlers.
|
| |
| void | validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage) |
| | Validates property modifiers and notifies handlers.
|
| |
| RenderPass * | getThisObject () |
| | Internal accessor for the Curiously Recurring Template Pattern.
|
| |
| const RenderPass * | getThisObject () const |
| | Internal accessor for the Curiously Recurring Template Pattern.
|
| |
| void | attachBindings () |
| | Attach all bindings stored in this object.
|
| |
| void | detachBindings () |
| | Detach bindings.
|
| |
Use the Composition Target Render Pass to set one to four composition targets and render all descendant render passes to the composition targets that the Composition Target Render Pass created.
If you set multiple composition targets, rendering can write to all specified buffers at the same time. See Using multiple composition targets. After Kanzi renders the descendant render passes of a Composition Target Render Pass, the Composition Target Render Pass restores the earlier composition settings.
Configuring the composition target
Composition Target Render Pass by default creates one composition target whose size is the same as the size of the current Viewport 2D node using the RGBA pixel format and depth buffer. To configure the composition target, you can:
Using custom render target textures
You can set a Composition Target Render Pass to use a composition target texture that you create somewhere else with the CompositionTarget0Property property. The render pass for which you set the composition target texture with this property does not create its own render target.
Texture::CreateInfoNode2DRenderTarget createInfo(1280, 720, GraphicsFormatR8G8B8A8_UNORM);
TextureSharedPtr compositionTarget = Texture::create(domain, createInfo,
"Composition Target");
compositionTargetRenderPass->setCompositionTarget0(compositionTarget);
For example, to use a custom render target texture, bind the CompositionTarget0Property property of a Composition Target Render Pass to properties of other render passes. Use the DepthTargetProperty to set the depth texture.
To set a Composition Target Render Pass to render to multiple render target textures, use these properties to set each render target texture:
When you use the result target properties from other CompositionTargetRenderPass render passes to render incrementally into the targets, set the ResolveImmediatelyProperty to false in the original CompositionTargetRenderPass.
The size settings of the explicitly defined composition targets must match. If you do not explicitly define some of the composition targets, the size of the explicitly defined composition targets must match the size that Kanzi automatically calculates for the viewport. Kanzi discards all composition targets with mismatches in their sizes and instead creates a composition target automatically.
Accessing the composition target result
To access the result of a Composition Target Render Pass:
TextureSharedPtr resultCompositionTarget = compositionTargetRenderPass->getResultTexture0();
The texture that the getResultTexture0() function returns is not necessarily the texture that a Composition Target Render Pass rendered, or the texture set to the CompositionTarget0Property. For example, if you use multisampling, the getResultTexture0() function returns the target, where it resolves multiple samples into a 2D texture.
If a Composition Target Render Pass was not executed, the result of the getResultTexture0() function is undefined.
To use the result textures of a Composition Target Render Pass in another render pass, create bindings to these properties:
For example, in a Blit Render Pass you can bind the BlitRenderPass::Texture0Property to the ResultTexture0Property of a Composition Target Render Pass, the BlitRenderPass::Texture1Property to the ResultTexture1Property, and so on.
You can use the result texture properties to access the result textures of both the explicitly defined composition targets and the composition targets generated automatically by the Composition Target Render Pass.
To avoid needlessly updating the bindings that read these properties, Kanzi updates the values of these properties only when the associated composition targets change or disappear.
Use the ResolveImmediatelyProperty to set whether to resolve multisamples and generate mipmaps for the composition targets immediately after rendering. By default the Composition Render Target Render Pass resolves multisamples and generates mipmaps immediately, but if you use some or all of the composition targets for further rendering elsewhere, you can set the value of this property to false. This way you delay the resolve operations until the result composition target is referenced.
Using multiple composition targets
You can set a Composition Target Render Pass to render to up to 4 composition targets at the same time. To control the pixel format of a composition target, set its pixel format property:
The Pixel Format property with the highest index sets the number of composition targets that Kanzi creates for a Composition Target Render Pass. If you do not set some of the Pixel Format properties, those properties get their value from a Pixel Format property with a higher index whose value is set. For example, if you set the values of the PixelFormat0Property and PixelFormat2Property, Kanzi creates three composition targets and:
To set the same pixel format for all composition targets, you can set the corresponding highest-index pixel format property and remove the other pixel format properties.
Use the DepthTextureFormatProperty to set the format for a depth texture. When you do not set the DepthTextureFormatProperty, but the rendering settings require depth testing to render the child render passes, Kanzi automatically creates a depth renderbuffer. When you set the DepthTextureFormatProperty, Kanzi creates a depth texture that you can access with the ResultDepthTextureProperty.
To create a Composition Target Render Pass with multiple output textures:
mrt->addPropertyValue(CompositionTargetRenderPass::PixelFormat2Property,
Variant(GraphicsFormatR8G8B8A8_UNORM));
mrt->addPropertyValue(CompositionTargetRenderPass::DepthTextureFormatProperty,
Variant(GraphicsFormatD24_UNORM));
To use the result textures from a Composition Target Render Pass in a Blit Render Pass:
blit->addBinding(
BindingLoadInfo(Binding::create(
"../mrt", CompositionTargetRenderPass::ResultTexture0Property), BlitRenderPass::Texture0Property));
blit->addBinding(
BindingLoadInfo(Binding::create(
"../mrt", CompositionTargetRenderPass::ResultTexture1Property), BlitRenderPass::Texture1Property));
blit->addBinding(
BindingLoadInfo(Binding::create(
"../mrt", CompositionTargetRenderPass::ResultTexture2Property), BlitRenderPass::Texture2Property));
blit->addBinding(
BindingLoadInfo(Binding::create(
"../mrt", CompositionTargetRenderPass::ResultDepthTextureProperty), BlitRenderPass::Texture3Property));
Examples
To use a Composition Target Render Pass with a custom render target with automatic size:
screen->attach();
node->setWidth(static_cast<float>(width));
node->setHeight(static_cast<float>(height));
screen->addChild(node);
ColorBrushSharedPtr brush = ColorBrush::create(domain,
"brush", ColorRGBA(0.4f, 0.4f, 0.9f, 1.0f));
node->setBackgroundBrush(brush);
Texture::CreateInfoNode2DRenderTarget textureCreateInfo(1, 1, GraphicsFormatR8G8B8A8_UNORM);
textureCreateInfo.widthDivisor = 1;
textureCreateInfo.heightDivisor = 1;
TextureSharedPtr renderTarget = Texture::create(domain, textureCreateInfo,
"texture");
node->setRenderTarget(renderTarget);
node->setOffscreenRendering(true);
{
CompositionStack& compositionStack = renderer->getCompositionStack();
screen->setAllocatedSize(Vector2(static_cast<float>(width), static_cast<float>(height)));
screen->setArrangeTransform(Matrix3x3());
screen->layout();
compositionStack.pushComposition(0, screen->getAllocatedSize());
screen->render(*renderer, compositionStack);
compositionStack.popComposition();
}
screen->detach();
Public Types inherited from kanzi::RenderPass